Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(content-negociation): document how to declare an encoder for custom format #1797

Merged
merged 1 commit into from
Jan 15, 2025
Merged

docs(content-negociation): document how to declare an encoder for custom format #1797

merged 1 commit into from
Jan 15, 2025

Conversation

nikophil
Copy link
Contributor

fixes #994

@nikophil nikophil force-pushed the content-negociation/custom-format-encoder branch from d6cdf23 to 8dea009 Compare September 15, 2023 08:08
dunglas
dunglas requested changes Sep 16, 2023
View reviewed changes
core/content-negotiation.md Show resolved Hide resolved
core/content-negotiation.md Outdated Show resolved Hide resolved
@nikophil nikophil force-pushed the content-negociation/custom-format-encoder branch from 8dea009 to 7a12dda Compare September 16, 2023 15:42
@vinceAmstoutz vinceAmstoutz changed the base branch from 3.1 to 3.4 January 14, 2025 09:34
@vinceAmstoutz
Copy link
Contributor

Can I merge it? @soyuka @alanpoulain @dunglas

@dunglas
Copy link
Member

dunglas commented Jan 14, 2025

Can we create an encoder and register it using attributes instead of YAML config?

@vinceAmstoutz
Copy link
Contributor

Can we create an encoder and register it using attributes instead of YAML config?

Yes @dunglas, can you please document this @nikophil?

@nikophil
Copy link
Contributor Author

nikophil commented Jan 15, 2025 •
edited
Loading

This suggestion has already been made, but this cannot be done 😁
#1797 (comment)

@vinceAmstoutz vinceAmstoutz merged commit 85d6897 into api-platform:3.4 Jan 15, 2025
vinceAmstoutz added a commit that referenced this pull request Jan 15, 2025
@vinceAmstoutz @MickaelSchimpf @nikophil
Merge 3.4 in 4.0 (#2127)
720f200 
* docs(validation): add missing hook (#1795)

docs: add missing hook in validation.md for "Dynamic validation groups"

* docs(content-negociation): document how to declare an encoder for custom format (#1797)

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>
vinceAmstoutz added a commit that referenced this pull request Jan 15, 2025
@vinceAmstoutz @MickaelSchimpf @nikophil
Merge 4.0 into main (#2129)
582d250 
* docs(openapi): add custom UI template override for Laravel (#2113)

Added documentation on overriding the default OpenAPI UI template.

* docs(serializer): deprecation of annotations and fix broken link (#2118)

- Added detailed documentation about the deprecation of annotations in favor of attributes for Symfony >= 7.0.
- Updated configuration examples for both annotation-based and attribute-based serializers.
- Fixed a broken link to Symfony Flex documentation.

* Merge 3.4 in 4.0 (#2127)

* docs(validation): add missing hook (#1795)

docs: add missing hook in validation.md for "Dynamic validation groups"

* docs(content-negociation): document how to declare an encoder for custom format (#1797)

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>
vinceAmstoutz added a commit that referenced this pull request Jan 15, 2025
@vinceAmstoutz @MickaelSchimpf @nikophil
Merge 4.0 into main (#2130)
c12e64b 
* docs(openapi): add custom UI template override for Laravel (#2113)

Added documentation on overriding the default OpenAPI UI template.

* docs(serializer): deprecation of annotations and fix broken link (#2118)

- Added detailed documentation about the deprecation of annotations in favor of attributes for Symfony >= 7.0.
- Updated configuration examples for both annotation-based and attribute-based serializers.
- Fixed a broken link to Symfony Flex documentation.

* Merge 3.4 in 4.0 (#2127)

* docs(validation): add missing hook (#1795)

docs: add missing hook in validation.md for "Dynamic validation groups"

* docs(content-negociation): document how to declare an encoder for custom format (#1797)

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>

* fix(openapi): resolve unsupported blade markdown types by hugoserver

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>
vinceAmstoutz added a commit that referenced this pull request Jan 15, 2025
@vinceAmstoutz @MickaelSchimpf @nikophil
Merge 4.0 into main (#2131)
e2e9e6c 
* docs(openapi): add custom UI template override for Laravel (#2113)

Added documentation on overriding the default OpenAPI UI template.

* docs(serializer): deprecation of annotations and fix broken link (#2118)

- Added detailed documentation about the deprecation of annotations in favor of attributes for Symfony >= 7.0.
- Updated configuration examples for both annotation-based and attribute-based serializers.
- Fixed a broken link to Symfony Flex documentation.

* Merge 3.4 in 4.0 (#2127)

* docs(validation): add missing hook (#1795)

docs: add missing hook in validation.md for "Dynamic validation groups"

* docs(content-negociation): document how to declare an encoder for custom format (#1797)

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>

* fix(openapi): resolve unsupported blade markdown types by hugoserver

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>
vinceAmstoutz added a commit that referenced this pull request Jan 15, 2025
@vinceAmstoutz @MickaelSchimpf @nikophil
Merge 4.0 into main (#2132)
fa3bd28 
* docs(openapi): add custom UI template override for Laravel (#2113)

Added documentation on overriding the default OpenAPI UI template.

* docs(serializer): deprecation of annotations and fix broken link (#2118)

- Added detailed documentation about the deprecation of annotations in favor of attributes for Symfony >= 7.0.
- Updated configuration examples for both annotation-based and attribute-based serializers.
- Fixed a broken link to Symfony Flex documentation.

* Merge 3.4 in 4.0 (#2127)

* docs(validation): add missing hook (#1795)

docs: add missing hook in validation.md for "Dynamic validation groups"

* docs(content-negociation): document how to declare an encoder for custom format (#1797)

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>

* fix(openapi): resolve unsupported blade markdown types by hugoserver

---------

Co-authored-by: MickaelSchimpf <122897940+MickaelSchimpf@users.noreply.github.com>
Co-authored-by: Nicolas PHILIPPE <nikophil@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dunglas dunglas dunglas approved these changes

@alanpoulain alanpoulain Awaiting requested review from alanpoulain

@soyuka soyuka Awaiting requested review from soyuka

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing documentation to register a new encoder
4 participants
@nikophil @vinceAmstoutz @dunglas @alanpoulain